package com.powernode.config;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * Knife4j接口文档配置类
 * 用于配置Swagger/Knife4j接口文档的生成规则和展示信息
 * 提供API接口的可视化文档，方便前后端开发人员对接和测试
 */
@Configuration // 标记为Spring配置类，Spring会自动扫描并应用该配置
public class Knife4jConfig {
    /**
     * 创建API分组文档
     * 用于对API接口进行分组管理，便于文档的组织和查阅
     *
     * @return GroupedOpenApi对象，包含API分组的配置信息
     */
    @Bean
    public GroupedOpenApi webApi() {
        return GroupedOpenApi.builder()
                .group("bjpowernode") // 设置API分组名称，在文档页面中显示
                .pathsToMatch("/**") // 设置需要包含的API路径规则，/**表示匹配所有路径
                .build(); // 构建GroupedOpenApi对象
    }

    /**
     * 自定义API文档元数据
     * 配置API文档的标题、版本、描述等基本信息
     *
     * @return OpenAPI对象，包含API文档的元数据配置
     */
    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("秒杀API接口文档") // 文档标题
                        .version("1.0") // 文档版本
                        .description("秒杀API接口文档") // 文档描述
                        .contact(new Contact() // 联系人信息
                                .name("powernode") // 联系人名称
                                .url("http://www.bjpowernode.com") // 联系人网址
                        )
                );
    }
}